<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mcdma: xmcdma_bd.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mcdma
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xmcdma__bd_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xmcdma_bd.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga34e74ad4836bc9c82d3288ccc41516ae"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga34e74ad4836bc9c82d3288ccc41516ae">XMcdma_UpdateChanCDesc</a> (XMcdma_ChanCtrl *Chan)</td></tr>
<tr class="memdesc:ga34e74ad4836bc9c82d3288ccc41516ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update Current Descriptor for the MCDMA Channel.  <a href="group__mcdma.html#ga34e74ad4836bc9c82d3288ccc41516ae">More...</a><br/></td></tr>
<tr class="separator:ga34e74ad4836bc9c82d3288ccc41516ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7d613e34ee855d64d50a462e272bcf38"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga7d613e34ee855d64d50a462e272bcf38">XMcdma_UpdateChanTDesc</a> (XMcdma_ChanCtrl *Chan)</td></tr>
<tr class="memdesc:ga7d613e34ee855d64d50a462e272bcf38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update Tail Desc for the Channel.  <a href="group__mcdma.html#ga7d613e34ee855d64d50a462e272bcf38">More...</a><br/></td></tr>
<tr class="separator:ga7d613e34ee855d64d50a462e272bcf38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5cb928c2177632d162e1f83b9df818a4"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga5cb928c2177632d162e1f83b9df818a4">XMcDma_ChanBdCreate</a> (XMcdma_ChanCtrl *Chan, UINTPTR Addr, u32 Count)</td></tr>
<tr class="memdesc:ga5cb928c2177632d162e1f83b9df818a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Using a memory segment allocated by the caller, This function creates and setup the BD Chain for the MCDMA Channel.  <a href="group__mcdma.html#ga5cb928c2177632d162e1f83b9df818a4">More...</a><br/></td></tr>
<tr class="separator:ga5cb928c2177632d162e1f83b9df818a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga043e7eb1811040fdbdafe288cd4ac5ea"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga043e7eb1811040fdbdafe288cd4ac5ea">XMcDma_ChanSubmit</a> (XMcdma_ChanCtrl *Chan, UINTPTR BufAddr, u32 len)</td></tr>
<tr class="memdesc:ga043e7eb1811040fdbdafe288cd4ac5ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Populates the BD Chain with the required buffer address and length fields.  <a href="group__mcdma.html#ga043e7eb1811040fdbdafe288cd4ac5ea">More...</a><br/></td></tr>
<tr class="separator:ga043e7eb1811040fdbdafe288cd4ac5ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea3a22718a28af2430b0508f213b96d1"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gaea3a22718a28af2430b0508f213b96d1">XMcDma_Chan_Sideband_Submit</a> (XMcdma_ChanCtrl *ChanPtr, UINTPTR BufAddr, u32 Len, u32 *AppPtr, u16 Tuser, u16 Tid)</td></tr>
<tr class="memdesc:gaea3a22718a28af2430b0508f213b96d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function populates the BD Chain with the required buffer address, length APP(user application), TUSER and TID fields.  <a href="group__mcdma.html#gaea3a22718a28af2430b0508f213b96d1">More...</a><br/></td></tr>
<tr class="separator:gaea3a22718a28af2430b0508f213b96d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadccaaa44cfbb7f8c45790050fa14a9aa"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gadccaaa44cfbb7f8c45790050fa14a9aa">XMcDma_ChanToHw</a> (XMcdma_ChanCtrl *Chan)</td></tr>
<tr class="memdesc:gadccaaa44cfbb7f8c45790050fa14a9aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function triggers/Starts the h/w by programming the Current and Tail Descriptors and enabling the particular channel.  <a href="group__mcdma.html#gadccaaa44cfbb7f8c45790050fa14a9aa">More...</a><br/></td></tr>
<tr class="separator:gadccaaa44cfbb7f8c45790050fa14a9aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaab94e04161d34aae300d76dd51948117"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gaab94e04161d34aae300d76dd51948117">XMcdma_BdChainFromHW</a> (XMcdma_ChanCtrl *Chan, u32 BdLimit, XMcdma_Bd **BdSetPtr)</td></tr>
<tr class="memdesc:gaab94e04161d34aae300d76dd51948117"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a set of BD(s) that have been processed by hardware.  <a href="group__mcdma.html#gaab94e04161d34aae300d76dd51948117">More...</a><br/></td></tr>
<tr class="separator:gaab94e04161d34aae300d76dd51948117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac503b02c1b13e908931f84facd8eae44"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#gac503b02c1b13e908931f84facd8eae44">XMcdma_BdChainFree</a> (XMcdma_ChanCtrl *Chan, int BdCount, XMcdma_Bd *BdSetPtr)</td></tr>
<tr class="memdesc:gac503b02c1b13e908931f84facd8eae44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees a set of BDs that had been previously retrieved with <a class="el" href="group__mcdma.html#gaab94e04161d34aae300d76dd51948117" title="Returns a set of BD(s) that have been processed by hardware. ">XMcdma_BdChainFromHW()</a>.  <a href="group__mcdma.html#gac503b02c1b13e908931f84facd8eae44">More...</a><br/></td></tr>
<tr class="separator:gac503b02c1b13e908931f84facd8eae44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a2cc690650d389e820be2aa8a078024"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga2a2cc690650d389e820be2aa8a078024">XMcdma_BdSetBufAddr</a> (XMcdma_Bd *BdPtr, UINTPTR Addr)</td></tr>
<tr class="memdesc:ga2a2cc690650d389e820be2aa8a078024"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Buffer descriptor buffer address field.  <a href="group__mcdma.html#ga2a2cc690650d389e820be2aa8a078024">More...</a><br/></td></tr>
<tr class="separator:ga2a2cc690650d389e820be2aa8a078024"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2388e0cd3c27b0c675f308b74a0e6b21"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga2388e0cd3c27b0c675f308b74a0e6b21">XMcDma_BdSetCtrl</a> (XMcdma_Bd *BdPtr, u32 Data)</td></tr>
<tr class="memdesc:ga2388e0cd3c27b0c675f308b74a0e6b21"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the control bits for a BD.  <a href="group__mcdma.html#ga2388e0cd3c27b0c675f308b74a0e6b21">More...</a><br/></td></tr>
<tr class="separator:ga2388e0cd3c27b0c675f308b74a0e6b21"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga357821499f1231555343dc309c59c67a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga357821499f1231555343dc309c59c67a">XMcDma_BdSetAppWord</a> (XMcdma_Bd *BdPtr, int Offset, u32 Word)</td></tr>
<tr class="memdesc:ga357821499f1231555343dc309c59c67a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the APP word at the specified APP word offset for a BD.  <a href="group__mcdma.html#ga357821499f1231555343dc309c59c67a">More...</a><br/></td></tr>
<tr class="separator:ga357821499f1231555343dc309c59c67a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9295d5a6e89fe6a6471371191078b7fc"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga9295d5a6e89fe6a6471371191078b7fc">XMcDma_BdGetAppWord</a> (XMcdma_Bd *BdPtr, int Offset, int *Valid)</td></tr>
<tr class="memdesc:ga9295d5a6e89fe6a6471371191078b7fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the APP word at the specified APP word offset for a BD.  <a href="group__mcdma.html#ga9295d5a6e89fe6a6471371191078b7fc">More...</a><br/></td></tr>
<tr class="separator:ga9295d5a6e89fe6a6471371191078b7fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5a6f8e287e29edd291257dea37570c94"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga5a6f8e287e29edd291257dea37570c94">XMcdma_SetChanCoalesceDelay</a> (XMcdma_ChanCtrl *Chan, u32 IrqCoalesce, u32 IrqDelay)</td></tr>
<tr class="memdesc:ga5a6f8e287e29edd291257dea37570c94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set interrupt coalescing parameters for a particular channel.  <a href="group__mcdma.html#ga5a6f8e287e29edd291257dea37570c94">More...</a><br/></td></tr>
<tr class="separator:ga5a6f8e287e29edd291257dea37570c94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20e854946069868d98b43a144f282093"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mcdma.html#ga20e854946069868d98b43a144f282093">XMcDma_DumpBd</a> (XMcdma_Bd *BdPtr)</td></tr>
<tr class="memdesc:ga20e854946069868d98b43a144f282093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dump the fields of a BD.  <a href="group__mcdma.html#ga20e854946069868d98b43a144f282093">More...</a><br/></td></tr>
<tr class="separator:ga20e854946069868d98b43a144f282093"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
